﻿
//////////////////////////////////////////////////////////////////////////////
//
// Copyright © 1998-2024 Glodon Company Limited.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the “Software”),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//////////////////////////////////////////////////////////////////////////////
#pragma once

#include "IParameterDisplay.h"

namespace gcmp
{
    class IParameterValueStorage;
    class IDocument;
}

namespace Sample
{
    /// \brief Editbox参数显示类
    ///
    ///  描述参数以Editbox形式显示的类
    class UICOMPONENT_EXPORT IParameterDisplayEditbox : public IParameterDisplay
    {
    public:
        /// \brief 根据给定参数值，返回对应的显示字符串
        ///
        /// \param pDocument 文档指针
        /// \param pValue 参数值
        /// \return 显示字符串
        virtual std::wstring GetDisplayStringByValue(const gcmp::IDocument* pDocument, const gcmp::IParameterValueStorage* pValue) const = 0 ;

        /// \brief 根据给定显示字符串，返回对应的参数值
        ///
        /// \param pDocument 文档指针
        /// \param displayString 显示字符串
        /// \return 参数值
        virtual gcmp::OwnerPtr<gcmp::IParameterValueStorage> GetValueByDisplayString(const gcmp::IDocument* pDocument, const std::wstring& displayString) const = 0;
    };
}

